Webservice VoiceForm

VoiceCheck geeft een webservice weer waarin u een VoiceForm kunt maken—in wezen een gegevensimport. Deze webservice maakt het zowel mogelijk om nieuwe VoiceForms te maken als bestaande VoiceForms bij te werken of te verwijderen van de VoiceCheck-server. Als deze webservice wordt opgeroepen controleert VoiceCheck het systeem op het volgende:

• Als er geen overeenkomende VoiceForm-naam is, wordt er een nieuw VoiceForm gemaakt.
• Als er een overeenkomende VoiceForm-naam bestaat, wordt er geen nieuw VoiceForm gemaakt.

U kunt een VoiceForm met of zonder VoiceForm-stappen importeren. Op die manier kan een technicus de VoiceForm-stappen later maken vanaf de VoiceCheck-server.

Wanneer VoiceCheck dit bericht ontvangt voor lezen, bijwerken en verwijderen van VoiceForms, worden de volgende validaties in acht genomen:

• Als de VoiceForm-naam niet bestaat in VoiceCheck, worden er geen details geretourneerd in de reactie.
• Als het VoiceForm wel bestaat, kan de webservice alleen de naam van het VoiceForm bijwerken.
• Als het VoiceForm naar geen enkele andere entiteit verwijst in VoiceCheck, kan het worden verwijderd. Anders is verwijdering van het VoiceForm niet toegestaan.

Details VoiceForm maken

REST-webservice

WADL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceform?_wadl

URL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceform

Methode: POST

Type content: application/json;charset=UTF-8

Berichttekst: JSON zoals omschreven in het schema in de WADL. De elementen worden beschreven in de tabel Invoer elementen.

Reactie: Bij succes HTTP-status 200 met nettolading “VoiceForm opgeslagen”. Bij mislukking retourneert het systeem een foutmelding. Elke andere HTTP-statuscode dan 200 of 204 wordt als fout beschouwd. Indien mogelijk moet het hostsysteem een tekst voor fouten retourneren.

POST-parameters

Een VoiceForm-bestand met geldige parameters in de tekst.

DETAILS VOICEFORM LEZEN

REST-WEBSERVICE

WADL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceform?_wadl

URL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceform/{naamvoiceform}

Methode: GET

Type content: application/json;charset=UTF-8

Reactie: Bij succes HTTP Status 200 met of zonder tekst. Bij mislukking retourneert het systeem een foutmelding.

DETAILS VOICEFORM BIJWERKEN

WADL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceform?_wadl

URL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceform/bijwerken/{naamvoiceform}/{nieuwenaamvoiceform}

Methode: POST

Type content: application/json;charset=UTF-8

Reactie: Bij succes HTTP Status 200 met of zonder tekst. Bij mislukking retourneert het systeem een foutmelding.

DETAILS VOICEFORM VERWIJDEREN

WADL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceform?_wadl

URL: <http of https>://<host>:<poort>/VoiceCheck/services/voiceform/{naamvoiceform}

Methode: VERWIJDEREN

Reactie: Bij succes HTTP Status 200 met of zonder tekst. Bij mislukking retourneert het systeem een foutmelding.

Afbeeldingen beheren

REST-WEBSERVICE

WADL: <http of https>://<host>:<poort>/VoiceCheck/services/imageService?_wadl

URL: <http of https>://<VoiceCheckIP>:<poort>/VoiceCheck/services/imageService/<Directory/Mapnaam><Directory/Mapnaam>.....<naam fotobestand met extensie>

Methode: GET

Parameter: afbeeldingspad in het bestandssysteem met de naam van de afbeelding (verzending parameter in de URL)

Type content: (blanco)

Reactie: Bij succes HTTP-status 200. Als er geen foto wordt gevonden, genereert de service een WebAppplicationException met de status HTTP-status 404 - Niet gevonden.

Basisverificatie: Gebruikersnaam en wachtwoord voor VoiceCheck

INVOER ELEMENTEN

EIGENSCHAP	TYPE	VERPLICHT	DEFINITIE	VALIDATIE
voiceformname	Tekenreeks	Ja	De naam van het VoiceForm	Moet uniek zijn in VoiceCheck